home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Magnum One
/
Magnum One (Mid-American Digital) (Disc Manufacturing).iso
/
d3
/
rr2310.arc
/
READYREF.DOC
< prev
next >
Wrap
Text File
|
1988-12-18
|
61KB
|
1,366 lines
ReadyRef
========
An On-Line Reference
--------------------
Ver. 2.30(10)
by
W.G. Madison
Copyright 1988 W.G. Madison and Associates, Ltd.
All rights reserved.
┌─────────┐
┌────┴────┐ │ W. G. MADISON AND
──┤ │ ├───────────────── ASSOCIATES, Ltd.
│ ┌──────┴──┐ │ Association of P. O. Box 898
│ │ ├─┘ Shareware Greenbelt, MD 20770
└──┤ o │ Professionals (301)552-7234
─────┤ ║ ├─────────────────── (CIS 73240,342)
(tm) └────╨────┘ MEMBER
========================================================
| Shareware |
| |
| We encourage you to freely copy and share UNMODIFIED |
| copies of this program with other people. If you |
| decide to use the program, support the Shareware |
| marketing concept by becoming a registered user. |
========================================================
TABLE OF CONTENTS
=================
1. INTRODUCTION ..................................... 1
1.0 What is ReadyRef, and why should I bother? ....... 1
1.1 Acknowledgments .................................. 2
2. THE DISTRIBUTION SET ............................. 3
3. TEST DRIVING AND INVOKING READYREF ............... 3
3.1 Invoking ReadyRef and using its options .......... 4
4. INSTALLING READYREF .............................. 5
4.0 System Requirements .............................. 5
4.1 General considerations ........................... 5
4.1.1 Summary of the installation/configuration process. 6
4.2 Using RRCONFIG to initially configure ReadyRef ... 8
4.2.1 Selecting a color set ............................ 8
4.2.2 Selecting an initial option set .................. 9
5. DEFINING USER-CONFIGURABLE OPTIONS FROM SCRATCH .. 10
5.0 General discussion ............................... 10
5.1 Preparing a text file for a user definable option. 11
5.2 Using RRCONFIG to install a new option ........... 12
5.3 Searching a text file ............................ 13
5.4 Preparing and using configuration files .......... 15
6. INDEXING TEXT FILES .............................. 15
6.0 General discussion ............................... 15
6.1 Using RRINDEX .................................... 16
7. AVAILABLE READYREF-COMPATIBLE TEXT FILES ......... 16
8. USAGE/COPYING LICENSE ............................ 17
8.0 What is Shareware? ............................... 17
8.1 Your rights and obligations ...................... 18
8.2 Software/Shareware dealers and distributors ...... 19
8.3 How to register ReadyRef ......................... 19
8.4 User Support ..................................... 19
9. Other Shareware Products ......................... 20
1. INTRODUCTION
1.0 What is ReadyRef, and why should I bother?
All too frequently, if you are like me, you will be sitting at
your computer and want a quick piece of information. You have to
break your train of thought, find the book or document containing
the information you require, look it up, and then go back to the
computer and pick up where you left off. Even if the information
is on your hard disk and you have SideKick or SCOUT installed, it
can be a nuisance getting to, and reading the specific file you
want.
And most of the time (again, if you are like me) the information
you need amounts to only a few lines of text which could readily
be associated with a keyword.
ReadyRef MEETS THIS NEED!
ReadyRef is an on-line reference aid. Unlike most on-line refer-
ence aids, however, you decide for yourself the subject matter
for which you are most likely to need on-line assistance. You
decide for yourself the wording and form this assistance will
take. If you don't like what you have decided after using it for
a while, you can change it in any way you wish. In short, you are
not bound by someone else's decision as to what you want or need.
Thus, ReadyRef can, over time, become the reference aid specific-
ally designed for you and your work style.
ReadyRef can be used as a resident program (TSR) or can be run in
non-resident mode, runnable from the DOS prompt. It provides a
suite of up to 14 options, consisting of
* A complete ASCII table
* A calendar displaying any desired three month
period
* A date calculator, to determine
* the number of days between any two given
dates
* the date corresponding to any number of
days before or after a given date
* the day of the week on which any date, past
or future, falls
* Eleven additional options which you can define
for yourself, if you can use any editor or word
processor capable of producing an ASCII file.
* One of these options, providing reference
on the syntax and function of the more
common DOS commands, is pre-installed.
1
1.1 Acknowledgments
Nothing worthwhile is conceived or created in a vacuum. ReadyRef
is no exception. While the actual detailed design and coding may
be a solo effort, the ideas leading up to the design, the Beta
Testing support following initial implementation, and the contin-
ued feedback during the development process come from many
sources. Some of the contributors may not even be aware that,
during a free-wheeling conversation, a chance remark may have
lead to a valuable new view of a problem.
In particular,
To John Van Horn, Wallace Kendall, and Paul Demmitt for input
which, in many ways, determined some of the major features of
ReadyRef;
To John Newlin, who directed my attention to bodies of potential
users whose needs would have otherwise escaped my attention;
To both Johns, Wallace, and Paul (once again) as well as to the
many members of the Central Maryland Microcomputer Users' Group
who provided the frequently painful and embarrassing but neces-
sary Beta Testing services;
And finally, to my wife Frances, who has had to put up with late
nights and frequent bouts of the "dark grumps" while all of this
was taking place --
Much of the credit for any success which ReadyRef may enjoy is
rightfully yours. Thank you.
2
2. THE DISTRIBUTION SET
The files contained in the distribution set are:
RR.EXE The executable ReadyRef file
RR.OVR and its overlay file.
RRCONFIG.EXE The configuration program for ReadyRef,
which allows you to select a color set
to be used, and configures your options.
RRINDEX.EXE The text file indexing program for
ReadyRef. Processing long text files
with RRINDEX will permit direct access
of the file in keyword searching.
READ.ME A quick overview of ReadyRef.
READYREF.UPD The revision/update history of ReadyRef.
READYREF.DOC This file - the documentation file for
ReadyRef. Contains complete installation
and operating information, plus regis-
tration information and forms.
DOSCMD.SUM A text file summarizing commonly used
DOS commands, used by the pre-installed
"DOS commands" option.
AREACODE.SUM A summary of telephone area codes by
area code and state.
FONEBOOK.TXT A file which you can use as a pattern
for developing your own personal tele-
phone/address book for inclusion as a
ReadyRef option. Already contains some
useful phone numbers.
POSTAGE.SUM A summary of current (May, 1988) U.S.
domestic postal rates.
RR.CFG A general use configuration file which
installs options for telephone area
codes, U.S. domestic postal rates, and a
telephone/address book in addition to
the pre-installed DOS commands option.
ZAP.CFG A configuration file which de-installs
all user-definable options with the
exception of "DOS commands".
3. TEST DRIVING AND INVOKING READYREF
ReadyRef requires no special installation and has no unusual
system requirements. If you want to test drive ReadyRef in a
hurry and are willing for the moment to use it in its simplest
configuration, simply copy at least the following files to your
hard disk. Place all of these files, for the moment, in the same
directory.
RR.EXE
RR.OVR
DOSCMD.SUM
You are now ready to run ReadyRef as a non-resident application.
3
Make sure that the directory in which you placed the files is
your current directory, and enter "RR" (without the quote marks,
of course) from the DOS prompt.
3.1 Invoking ReadyRef and using its options.
Simply entering the DOS command "RR" will invoke ReadyRef as a
non-resident program. To install ReadyRef as a resident program,
you must first make sure that the three above mentioned files are
in a directory on your PATH, then enter the DOS command "RR /R".
(The space preceding "/R" is optional.)
To use ReadyRef in resident mode, it should be loaded before
SCOUT or SIDEKICK. After loading, it is invoked at any time (even
if you are in the middle of running another program) by pressing
Alt-Tab
The non-resident ReadyRef may be, of course, invoked any time you
are at the DOS prompt.
If you have a monochrome monitor, you may find the screen presen-
ted by ReadyRef difficult to read. If this is the case, enter "X"
(to exit from ReadyRef), then jump ahead in this document to
Section 4.1.1 paragraph 2. Change the color set being used,
according to the directions given there, and then come back here
to pick up where you left off.
When ReadyRef is invoked, you will be presented with the ReadyRef
main menu, with the cursor bar resting on the first option. You
can move the cursor bar up or down by using the arrow keys, and,
when the cursor bar is positioned over the desired option, press
either <RET> or <ESC>. Alternatively, you can invoke an option
without explicitly moving the cursor bar simply by pressing the
highlighted index letter corresponding to the option desired.
As the cursor bar is moved or when the index letter is pressed, a
help line will appear centered on the screen above the main menu.
This line will give you a very brief description of the expected
user input for the option.
When you are through using any option, pressing <ESC> will return
you to the menu. If you have been using the Date Calculator,
pressing <ESC> will return you to the Date Calculator sub-menu,
and pressing <ESC> again will return you to the main menu.
When at the main menu, pressing "X", or placing the cursor bar
over the "X" entry and pressing <RET> (<ESC> won't work from
here), will cause you to exit from ReadyRef.
4
4. INSTALLING READYREF
4.0 System Requirements
Hardware: PC/XT/AT/PS or close compatible. Hard disk prefer-
able, but not absolutely required. ReadyRef cur-
rently requires slightly over 69k of RAM.
Software: DOS 2.0 or above.
Configuration: ReadyRef uses three file handles internally.
Therefore, you should increase the FILES parameter
in your CONFIG.SYS file by three if you will be
using ReadyRef in resident mode. If you are un-
familiar with CONFIG.SYS or with the FILES param-
eter, please refer to your DOS reference manual.
4.1 General considerations.
Copy all of the files in the distribution set to your hard disk,
into either one or two directories on your DOS PATH. If you are
unfamiliar with the PATH concept, please refer to your DOS refer-
ence manual.
The files READ.ME, READYREF.DOC, and READYREF.UPD can be deleted
as soon as you have no further need for them on-line.
The files should be kept together as follows. They can either all
be in the same directory, or may be split up according to the
following list. (Note the distinction between "must" and
"should".)
RR.EXE
*.CFG must be in the RR.EXE directory.
RR.OVR should be in the RR.EXE directory.
RRCONFIG.EXE should be in the RR.EXE directory.
*.SUM
FONEBOOK.TXT must be in the *.SUM directory.
RRINDEX.EXE should be in the *.SUM directory.
If you are intending to use ReadyRef primarily as a non-resident
application (i.e., you have no need or desire to bring ReadyRef
up when you are in the middle of some other program), copy the
files to (a) director(y)(ies) which occurs early in your PATH. If
ReadyRef resides in a directory near the end of the PATH, espe-
cially if the PATH is long, the initialization of ReadyRef will
be slightly slowed down whenever it is invoked.
If you are intending to use ReadyRef in resident mode, it makes
little difference where in the PATH the files occur, except that
the grouping indicated above must be preserved.
5
4.1.1 Summary of the installation/configuration process.
The normal trial and installation sequence would normally proceed
as follows:
1. Test drive ReadyRef. Place at least RR.EXE, RR.OVR, and
DOSCMD.SUM in directories which are in your DOS PATH.
They need not be all in the same directory, but they
should all be on the PATH. Now you are ready for a test
drive. Just enter the command "RR" from the DOS prompt
and have fun.
Don't worry if you can't spell. If you're not sure of
the spelling of a keyword you want to search for, just
enter the first few letters. ReadyRef will take over
from there. The first text block displayed may not be
the one you want, but you can quickly step through
until you find the desired one. Try it.
2. Don't like the colors you see? Place RRCONFIG.EXE in the
same directory as RR.EXE, enter RRCONFIG from the DOS
prompt, and change to one of the other provided color
sets (Section 4.2.1). After selecting the color set,
accept the default answer to the next query by pressing
<RET>. Now go back to Step 1 for another test drive.
3. Want to add some of the other options provided (e.g.,
telephone area codes)? First, make sure that the asso-
ciated text file (e.g., the supplied file AREACODE.SUM)
is in THE SAME DIRECTORY as DOSCMD.SUM. Then, once
again, run RRCONFIG and this time accept the current
default color set by pressing <RET>. Answer "Y" to the
next query, and define the option you want (see below
for the details). Once again, go back for another test
drive. If you don't like something about the way you
have defined the option (the wording you have selected
for one of the defined strings), simply re-define it by
re-running RRCONFIG, re-selecting the option in ques-
tion, and changing only the string you don't like. The
ones you want to keep you may accept just by pressing
<RET> when the string is presented.
4. Want to really get your feet wet by defining an option
all your own? Just prepare a text file to be used by
the option according to the rules given below, then go
back to Step 3. (A look at the files DOSCMD.SUM,
AREACODE.SUM, and/or FONEBOOK.TXT might be useful at
this point.)
6
5. Want to get rid of an option that you have previously
defined? Go to Step 3 and select the offending option.
Then simply enter "UNDEFINED" (must be upper case) for
the main menu entry. You can change any of the other
control strings if you wish, but it's not necessary.
ReadyRef will ignore any options for which the main
menu entry is "UNDEFINED".
6. ReadyRef is the way you want it. Now make it a resident
application. Enter the command "RR /R" from the DOS
prompt. ReadyRef will now attach itself to DOS and be
ready to use at any time simply by simultaneously
pressing ALT-Tab. ReadyRef is extremely well behaved,
and will not interfere with most other TSR's (resident
programs) which you may be using. If, however, you are
using SCOUT or SIDEKICK, ReadyRef should be loaded
BEFORE either of these. The easiest way to make sure of
this is to load the TSR's from within your AUTOEXEC.BAT
file. (If you are not using SCOUT, you should at least
give it a try. I never liked shells of any kind until I
tried this one, and I'm now a dyed-in-the-wool convert!
It's probably available in the same library or BBS from
which you obtained ReadyRef.)
7. ReadyRef is all loaded, but now you want to test out a
new option before making it permanent. No problem. Just
go back to Step 4, and play to your heart's content.
ReadyRef can be run as a non-resident program even
after it has been made resident. Of course, once you
have this new option set up the way you want it, you
will need to re-boot before the change will become
available in the resident copy. (Changes to the text
file become effective as soon as the file is placed in
the directory in which ReadyRef expects to find them.
No need to re-boot if all you are doing is modifying
the text file -- only if you are changing the control
strings.)
8. ReadyRef and all its applications are just the way you
want them, but one or more of your text files is so
long that you get impatient waiting for the results of
a keyword search. RRINDEX.EXE to the rescue!!! Simply
run RRINDEX from the DOS prompt (of course, you are in
the directory in which all of the text files are
located, right?) and respond to the query by providing
the NAME.EXT of the text file you are getting impatient
with. Alternatively, you can bypass the prompt by
providing the NAME.EXT of the file to be indexed on the
command line.
RRINDEX will build a file having the same name as
the text file, but with an extension of NDX. Thus, if
you start with MYOPTION.TXT, you will end up with the
two files MYOPTION.TXT and MYOPTION.NDX. The .NDX file
is a special index file usable by ReadyRef to quickly
7
and directly find the desired entry when using a key-
word search. NOTE!! THIS INDEX FILE ***MUST*** BE RE-
CREATED OR DELETED ANY TIME YOU MAKE A CHANGE TO THE
ASSOCIATED TEXT FILE. FAILURE TO DO SO MAY CAUSE YOU TO
GET GARBAGE DISPLAYED.
4.2 Using RRCONFIG to initially configure ReadyRef.
The program RRCONFIG.EXE serves two purposes; to enable you to
select a color set to be used by ReadyRef, and to add or modify
the configurable main menu options.
When RRCONFIG is run, it will first ask you for the name of the
executable file to be configured, and present you with the
default name of "RR.EXE". While it is not recommended that you
rename RR.EXE to anything else, it can be done. (Note: RR.OVR
must NEVER be renamed.) Assuming that you have followed recom-
mended practice (you have not renamed RR.EXE), accept the default
by pressing <RET>.
RRCONFIG will then ask you what color set is to be used by Ready-
Ref, and the default is that color set currently in use. See
Section 4.2.1 below for additional details on this option.
Finally, RRCONFIG will ask you if you wish to change any of the
user definable options, and will present you with the default
"N". See Section 4.2.2 below for additional details on this
option.
Tips on using RRCONFIG.
If you wish to accept a displayed default (which may appear
either highlighted or in square brackets ("[...]")), simply press
<RET>. Should you wish to make only minor changes, you can use
the normal DOS editing keys. If, finally, you wish to completely
re-enter the option, simply start typing. You need not delete the
old option. It will be deleted any time the first key pressed is
other than an editing key.
4.2.1 Selecting a color set.
ReadyRef is distributed using a color set designed for a color
monitor. If you have a monochrome monitor, these colors may be
difficult or impossible to read. Two other color sets are pro-
vided, however. One set is designed for use with a monochrome
monitor driven by a color adapter (CGA/EGA/VGA), the other for
use with a monochrome adapter (MDA).
To install one of the alternate color sets (or to return to the
original color set), simply go to the directory in which you have
installed RR.EXE, and run the program RRCONFIG. You will be asked
to provide the name of the ReadyRef executable file, and pre-
8
sented with a default name ("RR.EXE"). If you have not renamed
RR.EXE to something else, simply press <RET>. If you have renamed
the file, enter the new name. (You don't need to enter the exten-
sion ".EXE" unless you feel like it.)
You will then be given a choice of three color set indices, with
the current selection as the default. Enter the selection which
best describes your needs, as determined by the descriptive text
on the screen.
Unless you wish to install or redefine one or more configurable
options (see below), press <RET> to accept the "No" default in
response to the next query.
When RRCONFIG exits to DOS, the new color set will have been in-
stalled. If you have installed ReadyRef as a resident program,
however, you will need to re-boot your computer before the new
colors will take effect.
4.2.2 Selecting an initial option set.
Two configuration files are provided as part of the distribution
set for ReadyRef. These files are those with an extension of
".CFG". Specifically,
RR.CFG A general use configuration file which
installs options for telephone area
codes, U.S. domestic postal rates, and a
telephone/address book in addition to
the pre-installed DOS commands option.
ZAP.CFG A configuration file which de-installs
all user-definable options with the
exception of "DOS commands".
To use either of these .CFG files, simply go to the directory in
which you have installed RR.EXE, and run the program RRCONFIG.
You will be asked to provide the name of the ReadyRef executable
file, and presented with a default name ("RR.EXE"). If you have
not renamed RR.EXE to something else, simply press <RET>. If you
have renamed the file, enter the new name. (You don't need to
enter the extension ".EXE" unless you feel like it.)
Now, since you presumably don't want to change color sets at this
time, accept the current color set by pressing <RET> in response
to the next query.
The query will now be presented which will give you the oppor-
tunity to add or modify user definable options, and the default
response is "N". Press "Y" to override the default. You will be
presented with a split screen. In the upper half will be dis-
played the main menu entries for the defined options, or the word
"UNDEFINED". Pay no attention to that portion of the screen at
this time.
9
The cursor will be in the bottom half of the screen, and you will
be queried for the index letter of the option you wish to define.
Enter "R" (for "READ").
You will be prompted for a configuration file name, with RR.CFG
being the default. Respond with the name (providing the extension
is optional) of the desired configuration file as described
above, and the defined option set will be installed.
You will again be queried for the option to be changed. Press
<ESC> to cause the new option set to be installed and leave
RRCONFIG. You will be returned to the DOS prompt.
5. DEFINING USER-CONFIGURABLE OPTIONS FROM SCRATCH
5.0 General discussion.
ReadyRef gives you the opportunity to define as many as eleven
options of your own. These options are all generically related,
in that they all provide for searching a text file for a partic-
ular string which you provide when you activate the option.
ReadyRef searches the text file in one of two modes, keyword
search or full text search. The determination of which mode will
be used is a function of the form of the search, or "pattern",
string which you enter at activation time. (See Section 5.3 for
additional detail)
* A KEYWORD search will be initiated if the search string
contains no "wild card" characters ("*", "?"). This is
much the faster of the two modes, and should be used
whenever possible for this reason.
If you're unsure of the actual spelling of a keyword in
your text file, simply entering the first few letters
will find it. For example, if the keyword is "FOOBAZ",
entering "FOOB" or "FO" or even just "F" will find
"FOOBAZ". The search is not case sensitive; either the
keyword in the file or the search string or both can be
either upper, lower, or mixed case.
If an index file is present (we'll get to that further
on in the discussion - Section 6) when a keyword search
is initiated, it will be used. If it is not present,
the text file will be keyword searched directly. [You
will probably want to index any files in excess of 750
or so lines. (Lines of text is really more of a deter-
mining factor than is the file size in bytes.)]
* A FULL TEXT search will be initiated if the search string
contains one or more wild card characters. In this
case, the string is taken to be a "pattern" against
which each line of the file is to be matched, BEGINNING
WITH THE START OF THE LINE. Thus, if you want to find a
10
word or phrase which may occur other than at the begin-
ning of a line, the search string must begin with a
wild card. (See the example below.)
The wild card characters have their usual DOS meanings.
The "*" means "zero or more occurrences of any charac-
ters", and the "?" means "exactly one character". Pro-
cessing of the "*", however, differs slightly from the
way it is processed by DOS. ReadyRef does not stop
scanning when it encounters the "*", whereas DOS stops
scanning as soon as a "*" is encountered.
This means that, for example, if the file contains two
strings "FOOBAZ" and "FOOBAT" and the search string is
"FOO*Z", ReadyRef will locate only "FOOBAZ" whereas the
DOS algorithm will locate both.
Note that in the above example, the search string would
have to occur at the beginning of a line, since you are
not telling ReadyRef to "skip 0 or more characters
prior to the initial 'F'". If you wanted to find the
string EVEN IF IT OCCURRED IN THE MIDDLE OF A LINE, you
would prefix it with another "*", as "*FOO*Z".
5.1 Preparing a text file for a user definable option.
In changing the provided files, or in creating your own files for
use by ReadyRef, a few simple formatting rules must be observed.
The file will be composed of a sequence of "text blocks". Each
text block will be composed of keywords and associated descrip-
tions.
1. The file must be an ASCII file. For example, if you use
WordStar to create or modify the file, use non-document
mode.
2. Each keyword must begin in column 1. The descriptions
themselves MUST NOT use column 1 as a left margin. (This
will slow down a keyword search, and, if you index the file,
will produce spurious entries in the index file). A descrip-
tion CAN begin or be continued on a line containing a key-
word, just as long as the keyword begins in column 1. (See
the provided file FONEBOOK.TXT)
3. Text blocks must not exceed 15 lines, including any key-
words which you may have placed alone on a line. Lines after
the 15th will be ignored. Line length is limited to 76 char-
acters. Any lines exceeding this length will be truncated,
and the truncated portion will not be searched.
11
4. As many keywords as desired may be applied to any
description, provided only that the 15 line limit is
observed. (See the entry for CHDIR and CD in DOSCMD.SUM as
an example.)
5. At least one blank line must follow each text block,
including the last. Ideally, 2 or more blank lines should
follow the last text block.
6. Blank lines must not be embedded in any description. A
blank line signifies the end of a text block.
7. The key words need not be in any particular order, either
within the text block or within the file.
5.2 Using RRCONFIG to install a new option.
The eleven configurable options in ReadyRef are defined by eleven
"Application Control Blocks" (ACB). Each ACB contains the defini-
tion of one configurable option. These definitions consist of
five entities (control strings); respectively
1. The text for the entry to be placed in the main
menu,
2. The text to be placed as the header in the display
window which will be used by the application,
3. The text of the HELP line appearing above the
window,
4. The text of the prompt to be used for entering the
string to be searched, and
5. The name and extension of the text file to be
searched by the option.
Initially, all of the ACB's with the exception of the first con-
tain the text "UNDEFINED" for the main menu entry. This tells
ReadyRef not to include a menu entry for that option (regardless
of what may be contained in the other ACB control strings). [The
first ACB contains the control data for the "DOS commands"
option. It, like any of the others, however, may be changed to
suit your particular needs or taste.]
The program RRCONFIG.EXE permits you to edit any or all of the
ACBs, placing whatever you wish in any of them.
Once a text file has been prepared according to the rules given
above, you are ready to install it in a ReadyRef option.
12
1. Make sure that the text file just prepared is in the same
directory as all of your other ReadyRef text files. If you did
not prepare it in that directory, copy it over.
2. Move to the directory containing RR.EXE, and run RRCONFIG.
3. Accept the color set option by pressing <RET> and respond "Y"
to the next query. A split-screen will be presented, in the upper
portion being displayed the menu entries for all eleven Applica-
tion Control Blocks. In the lower portion, you will be prompted
for the index letter of the entry you wish to change. (Note that
these index letters DO NOT correspond to the index letters which
will appear in the ReadyRef main menu.)
After you enter the index letter, the current contents of the
application control block (ACB) will be displayed, and you will
be prompted to provide new information on each item, in turn. A
<RET> accepts the current contents, unchanged. An <ESC> at any
time before entry of the last item will abort the process without
making any changes with respect to that ACB.
5. When you have finished changing the options, an <ESC> in res-
ponse to the query for an "application to change" will cause you
to leave the configuration program, and will make the changes
permanent (at least, until you run RRCONFIG again).
***NOTE***NOTE***NOTE***NOTE***NOTE***
ALL TEXT FILES TO BE USED WITH READYREF **MUST** BE IN THE SAME
DIRECTORY, AND THAT DIRECTORY **MUST** BE IN YOUR PATH. IF THIS
CONDITION IS NOT MET, READYREF WILL NOT BE ABLE TO FIND THE FILES
WHEN THEY ARE NEEDED.
Should you wish to eliminate one of the configurable options,
simply set its main menu entry to "UNDEFINED" (must be upper
case). You need not be bothered deleting the other entries for
the option. See application option "K" on menu for an example. I
use this one to test out new data files before permanently
installing them, and all I need to do is change the "UNDEFINED"
to something else, and then change it back when I'm through
testing.
Of course, if you are running ReadyRef in resident mode, you will
have to re-boot and re-install ReadyRef in resident mode for the
changes to become effective.
5.3 Searching a text file.
When you invoke a configurable option from the ReadyRef main
menu, you will be asked to provide a string against which the
file is to be searched. This string search is not case sensitive;
the search string may be in either upper or lower case, and can
13
contain the normal DOS wild-card characters. The "*" wild card is
interpreted slightly differently from the way in which DOS inter-
prets it, however.
Somewhat simplistically, if a search string DOES NOT CONTAIN a
"*" or "?", a key-word search will take place (a key-word, in
this case, being defined as any word beginning in column 1 of the
text file being searched). In contrast, if the search string DOES
CONTAIN a "*" or "?" (other than in the last character position),
a full-text search will take place. Not surprisingly, a key-word
search is much faster than a full text search when searching a
long text file.
ReadyRef automatically appends a "*" to the end of the search
string you provide. (This does not affect the mode of the search.
Keyword or full text searching is controlled ONLY by the search
steing YOU provide.) Thus, if you are unsure of the exact spelling
of a search key, you need only provide the first few letters.
ReadyRef will find the desired entry -- perhaps not the first
text block to be displayed, but you can step through until you
find the one you want.
In a bit more detail:
When DOS encounters the "*" character, it is taken to represent
zero or more arbitrary characters, and further scanning ceases.
Contrariwise, when ReadyRef encounters the "*", it is also inter-
preted as zero or more characters, but scanning does not stop.
This means, for example, that if you were to enter "ab*cd" in
response to the prompt, ReadyRef would match on the strings
"abcd" or "ab-how now brown cow-cd" but would fail to match on
the string "abdc". The DOS algorithm, on the other hand, would
match all three examples.
To illustrate the power of ReadyRef's use of the "*", assume the
following scenario.
Assume you have invoked the "DOS commands" option. You know that
there is a command which has to do with copying one floppy disk
to another, but can't remember the command. Simply enter the
search string "*floppy", and ReadyRef will search the full text
of all text blocks until one containing the string "floppy" is
found. (Remember, the preceding "*" means that any characters
before the string "floppy" will be ignored in the searching - a
full text search will be performed.)
If you try out the above example, you will find that two text
blocks will be displayed. The first will describe the "DISKCOPY"
command, the second will describe "DISKCOMP".
14
Now try the same experiment without using the "*" prefix. You
will find that no text blocks will be displayed, since ReadyRef
is looking for "floppy" at the beginning of a line (i.e., with no
characters preceding "floppy" in the line). There is no DOS
command (i.e., there is no keyword) "FLOPPY...".
5.4 Preparing and using configuration files.
You have already visited the use of configuration files if you
have gone through the exercise of Section 4.2.2.
To prepare your own configuration files, however, just follow the
steps below. [You might want to prepare separate configuration
files, for example, if you wanted to have different user config-
urable option sets available for different projects which you are
working on.]
Let's assume that you are in RRCONFIG and have just finished
installing a set of options. They are now exactly the way you
want them. When the prompt appears asking which item to change,
answer "W" (for "write"). You will now be prompted for a config-
uration file to write, with "RR.CFG" as the default. Either
accept the default, or provide a name of your own choosing. If
you provide no extension, ".CFG" will be used. After you enter
the name, a file will be written which contains the configuration
information for the configurable option set you have just
defined.
To install the option set contained in a configuration file,
follow the same procedure which was described in Section 4.2.2.
6. INDEXING TEXT FILES
6.0 General discussion.
You may find that, even when using keyword searching, the waiting
time is undesirably long before the desired text block is dis-
played. Preparation and use of an "index file" will materially
shorten this waiting time (it won't help a full text search,
however).
Files longer than approximately 750 lines of text will exhibit
noticably improved performance if they are indexed. Files shorter
than approximately 500 lines will be degraded in search perform-
ance. Between 500 and 750 lines, there is no appreciable differ-
ence. (You may want to experiment a bit, since these figures are
based on one particular configuration, with a relatively fast
hard disk. Experimentation is relatively painless, since the
indexing process is quite fast.)
15
6.1 Using RRINDEX.
To prepare an index file for a particular text file, go to the
directory in which your text files are housed and run the pro-
vided RRINDEX program from the DOS prompt. RRINDEX will prompt
for the text file NAME.EXT to be indexed.
Enter the text file name and press <RET>. RRINDEX will prepare a
file having the same name as the text file, but with an extension
of .NDX. Now, when ReadyRef is asked to perform a keyword search
of the text file, it will automatically use the .NDX file to
directly locate the beginning of the appropriate text block for
display.
Note that, should you change the text file in any way, the file
must be re-indexed or the index file must be deleted. Fail to
perform this simple step, and you run the risk of being presented
with a spectacular screen full of meaningless garbage.
After indexing a file it is not necessary to re-boot for a resi-
dent copy of ReadyRef to use indexed searching. The presence or
absence of the index file is determined at the time a search is
initiated, not at the time ReadyRef is installed.
7. AVAILABLE READYREF-COMPATIBLE TEXT FILES.
The following sets of additional ReadyRef-compatible text files
are available from Madison and Associates.
1. RR-ZIP A file containing the U. S. Postal Service 5-digit
ZIP code directory. Free with registration. (Available June,
1988)
2. RR-TP4 A set of files describing all of the TURBO PASCAL
4.x statements, in both Bakus-Naur notation and syntax dia-
grams; a description of all sub-programs in all units of the
standard Borland release (with the exception of those con-
tained in the GRAPH, GRAPH3, and TURBO3 units; a summary of
all run time and I/O error codes. As an added bonus, a file
is included summarizing all of the sub-programs contained in
Turbo 4.0 Professional by TurboPower Software. $10.00
3. RR-TB A set of files similar in content to RR-TP4, but
for TURBO BASIC. $10.00 (Available July, 1988)
4. RR-TC A set of files similar in content to RR-TP4, but
for TURBO C. $10.00 (Available August, 1988)
Are there other files or file sets which you feel should be
made available from ReadyRef? Let us know -- we are always open
to suggestions.
16
Also, if you wish to prepare a file yourself for inclusion,
contact us. We have a generous royalty plan available for just
such situations.
8. USAGE/COPYING LICENSE
- The software described herein and the accompanying documen-
tation is copyrighted and the sole property of W. G. Madison
and Associates, Ltd.
- W. G. Madison and Associates, Ltd. reserves the right to
make improvements in the product described in this documen-
tation and/or to the documentation at any time and without
notice.
8.0 What is Shareware?
Computer users and programmers have been exchanging software
since the dawn of computers. Only recently, however, has the
concept blossomed into an effort to provide low-cost alternatives
to conventional commercially marketed software. Known as Share-
ware, this concept provides a source of high quality software
products to users, and permits them the opportunity to "try
before you buy". Also, because expensive advertising and distri-
bution costs are avoided, the cost of Shareware tends to be sig-
nificantly lower than for a commercial product of equivalent
quality and functionality.
Shareware authors hold copyrights on their programs. Just as for
commercial software, the Shareware author's software is pro-
tected by U.S. and international copyright law. Shareware, un-
like its commercial counterpart, may be freely copied and passed
to others. Like commercial software, Shareware is a "for-sale"
product and Shareware authors request or require that people who
try their software and decide to use it send a "registration
fee" (approximately equivalent to purchasing the software). In
addition to granting a license to use the product for this regis-
tration fee, authors offer a wide variety of services to include
(depending on the program) printed documentation, disks, advanced
versions, and/or telephone support. Some companies also offer
free updates and commissions. But, the most important benefit of
registration is that you receive a legal license to continue
using the software.
Some Shareware authors have formed the Association of Shareware
Professionals (ASP) dedicated to establishing recognized stan-
dards for Shareware programs and authors. The authors share a
code of ethics and have agreed to adhere to the ASP's standards
for software and documentation. The ASP is also striving to help
disk dealers, the media, and the public to understand the nature
and benefits of Shareware. Through cooperation and mutual stan-
dards, the ASP hopes to promote Shareware as a viable alternative
17
to commercial software. Not all authors belong to ASP, but as
more join, Shareware standards will be more universally followed.
8.1 Your rights and obligations.
License
A limited license is granted to freely use, copy and distri-
bute the product subject to the following restrictions:
You may not:
- Sell and/or distribute the product for a fee, either alone
or along with other products, without express written per-
mission of the copyright holder.
- Grant sublicense, leases, or other rights in the software to
others.
- Modify or remove the Copyright notice from the program,
diskette or the documentation.
- Modify the program, diskette or documentation and/or merge
it into another program or product for any machine.
Distribution
ReadyRef is specifically authorized for distribution, under
the SHAREWARE principle, via public electronic bulletin boards or
by individual copying. Any distribution thus made must be in the
form of this entire .ARC file, UNALTERED, including the program
executable files, data files, and this or any other accompanying
documentation files. NO OTHER FORM OF DISTRIBUTION, INCLUDING
DISTRIBUTION AS PART OF A LARGER PACKAGE, NOR DISTRIBUTION FOR A
FEE (other than a nominal copying charge not to exceed $10.00),
IS AUTHORIZED WITHOUT SPECIFIC WRITTEN PERMISSION OF THE COPY-
RIGHT HOLDER.
Limited Warranty
THE PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PAR-
TICULAR PURPOSE. THE ENTIRE RISK AS TO QUALITY AND PERFORMANCE OF
THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
ASSUME THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR OR
CORRECTION. SOME STATES DO NOT ALLOW THE EXCLUSION OF IMPLIED
WARRANTIES SO THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. THIS
WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS AND YOU MAY ALSO HAVE
OTHER RIGHTS WHICH VARY FROM STATE TO STATE.
Limitation of Remedies
IN NO EVENT WILL W. G. MADISON AND ASSOCIATES, LTD. BE
LIABLE FOR ANY DAMAGES INCLUDING ANY LOST PROFITS, LOST SAVINGS
OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE SUCH PROGRAM EVEN IF W. G. MADISON AND
ASSOCIATES, LTD. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES OR ANY CLAIM BY ANY OTHER PARTY.
18
8.2 Software/Shareware dealers and distributors.
Please write to the Author for permission to include this
product in your collection PRIOR TO offering it for sale or dis-
tribution. Inquiries are encouraged, and will be responded to as
quickly as possible.
8.3 How to register ReadyRef.
If you find the program useful, and continue to use it past a
30-day trial period, you are required to register it. You can
register by completing the accompanying registration form and
sending it, with a check or money order in the amount of
$25.00 (if foreign funds, at current exchange rate) to Madison
and Associates at the address shown on the registration form
below. For those wishing to use VISA or Master Charge, on-line
registration can be made by calling the Shareware Products BBS at
619/455-5226 between the hours of 7:00AM and 11:00PM (PST).
Registration provides the following benefits:
0. Elimination of the initial registration reminder screen.
1. A ReadyRef-compatible 5-digit ZIP code directory.
2. The right to purchase other ReadyRef-compatible text files
as these become available from Madison and Associates. (See
the Order / Registration form on the last page for a list of
available text files.)
3. Full Telephone support.
4. Free major updates for a one year period, sharply discounted
rates thereafter.
5. Inclusion on our mailing list so that you may receive new
product announcements and notification of new ReadyRef text
files of general interest.
6. You will be in compliance with federal copyright law.
8.4 User Support
Registered users are provided with automatic notification of
major updates and availability of new ReadyRef-compatible text
files, and full telephone support. A recorder is provided
on the telephone number listed above, in case no one is in the
office, and a call-back will normally occur no later than the
next business day. Bug fixes or work-arounds will be mailed to
the complainant, if a registered user, and will also be uploaded
to CIS (IBMSW) and to major BBS's in the metropolitan DC area.
Telephone contact may normally be made between the hours of
7:00AM and 9:00PM (Eastern time), but see above. Non-registered
users are welcome to call, and will be accommodated on a "time
available" basis. Contact may, of course, always be made through
CIS EMAIL on the PPN given above.
19
9. Other Shareware Products
You may wish to try these other products of Madison and
Associates:
STORM - A comprehensive hard disk management aid. Provides:
1. Directory listing of all files on the disk,
sorted by NAME.EXT, Directory, or Size
(Decreasing).
2. Directory listing of all potentially duplicate
files on the disk.
3. Global deletion of all files matching a user-
supplied mask.
4. WHEREIS-type function to locate all files match-
ing a user-supplied mask.
5. Summary of disk usage by subdirectory.
6. Visual presentation of the directory structure of
the disk.
BPRINT - A utility to print files with banner pages. Prints
the name and extension in large block letters, fol-
lowed by a date/time stamp of when printed and the
home directory of the file.
QCRC - A utility to calculate the cyclic redundancy check
value of files. These CRC's may be directed to a
file, if desired. The file may later be used for
verification purposes, and may be freely edited to
include additional text. This combination of proper-
ties makes it extremely useful as a 'Table Of Con-
tents' file for diskettes.
VCOPY - An efficient utility for copying or moving files
between directories or devices, with true read-
after-write verification.
GETDOC - A utility which allows all your documentation files
to be collected together into a single .ARC file,
and later conveniently retrieved and displayed on
your console.
20
WGM&AL Registration & Comment Form
Name:___________________________________________________________
Company:________________________________________________________
Address:________________________________________________________
City:__________________________ State:_____ ZIP _______________
Telephone:(_____) _____-_______
ReadyRef Version:_____._____
Comment:
Payment:
Please register my copy of ReadyRef
$25.00
I also wish copies of the following ReadyRef-compatible
text files:
RR-TP4 ($10.00) ____.__
RR-TB ($10.00) ____.__
RR-TC ($10.00) ____.__
sub-total ____.__
(MD residents only) MD 5% Sales Tax ____.__
TOTAL ____.__
Mail To:
W. G. Madison and Associates, Ltd.
P.O. Box 898
Greenbelt MD 20770
